Skip to main content

Energy Balance - Required Attributes

The Energy Balance Analysis Rule requires that elements have specific Attributes and specific Attribute properties. Input and Output Attributes must be configured to be an allowable value type and have specific units of measure. Input and Output Attributes are listed in these sections:

Elements based on the Sigmafine Element templates are designed to be compatible with this data reference. Custom templates must have Attributes available with units of measure as listed in the following tables. The Attributes that the Sigmafine Element templates are designed to use are also noted in the tables in this section.

Element Attributes that are listed with multiple templates must have common naming across the named templates. The templates listed in these tables are based on mass – energy balance.

Energy Balance Analysis – Quantity Input Attributes

Analysis Configuration – Required Quantity Input Attributes

Configuration ParameterAttribute UnitTemplate Name(s)Default Attribute NameCategoryParameter Value Type
Measured QuantityMassSF_TankTemplateSF_LiquidMeterTemplateSF_TransferTemplateMeasuredMassSF_AnalysisInputDouble
Measured ToleranceMass\<same as above>MassTolerance\<same as above>Double
Object Status\<dimensionless>\<same as above>ObjectStatus\<same as above>String
Self Calculating Flag\<dimensionless>SF_TankTemplateSelfCalculatingFlag\<same as above>Boolean

Energy Balance Analysis – Quantity Output Attributes

Analysis Configuration - Required Quantity Output Attributes

Configuration ParameterAttribute UnitTemplate Name(s)Default Attribute NameCategoryParameter Value Type
Reconciled Status\<dimensionless>SF_TankTemplateSF_LiquidMeterTemplateSF_TransferTemplateSF_FlowTemplateInferredStatusSF_AnalysisOutputString
Reconciled QuantityMassSF_TankTemplateSF_TransferTemplateSF_FlowTemplateReconciledMass\<same as above>Double
Reconciled ToleranceMass\<same as above>ReconciledMass Tolerance\<same as above>Double
SolvabilityMass\<same as above>ReconciledMassSolvability\<same as above>Double
InfluenceMass\<same as above>ReconciledInfluence\<same as above>Double
Reconciled AdjustmentMass\<same as above>ReconciledMassCorrection\<same as above>Double
Test 1\<dimensionless>\<same as above>ReconciledMassTest1\<same as above>Double
Test 2\<dimensionless>\<same as above>ReconciledMassTest2\<same as above>Double
Initial ImbalanceMassSF_TankTemplateSF_NodeTemplateSF_ProcessTemplateSF_ManifoldTemplateReconciledMassImbalance\<same as above>Double
VarianceMass\<same as above>ReconciledMass Variance\<same as above>Double
Test 3\<dimensionless>\<same as above>ReconciledMassTest3\<same as above>Double
Test 4\<dimensionless>\<same as above>ReconciledMassTest4\<same as above>Double
Reconciled Residual\<dimensionless>\<same as above>ReconciledResidual\<same as above>Double

Energy Balance Analysis – Energy Input Attributes

Analysis Configuration - Required Energy Input Attributes

Configuration ParameterAttribute UnitTemplate Name(s)Default Attribute NameCategoryParameter Value Type
Specific Energy MeasurementSpecific EnergySF_SpecificEnergyMeterTemplateMeasuredSpecificEnergySF_AnalysisInputDouble
Specific Energy ToleranceSpecific Energy\<Same as above>SpecificEnergy Tolerance\<same as above>Double
Energy MeasurementEnergySF_EnergyMeterTemplateMeasuredEnergy\<same as above>Double
Energy ToleranceEnergySF_EnergyMeterTemplateEnergy Tolerance\<same as above>Double
Energy Balance FlagEnergySF_HeatExchangerTemplateSF_NodeTemplateSF_ProcessTemplateSF_ManifoldTemplateEnergyBalanceFlag\<same as above>Double

Energy Balance Analysis – Energy Output Attributes

Analysis Configuration - Required Energy Output Attributes

Configuration ParameterAttribute UnitTemplate Name(s)Default Attribute NameCategoryParameter Value Type
Reconciled Status\<dimensionless>SF_FlowTemplateReconciledEnergyStatusSF_AnalysisOutputDouble
Reconciled Specific EnergySpecific Energy\<same as above>ReconciledSpecificEnergy\<same as above>Double
Reconciled EnergyEnergy\<same as above>ReconciledEnergy\<same as above>Double
Solvability\<dimensionless>\<same as above>ReconciledEnergySolvability\<same as above>String
Influence\<dimensionless>\<same as above>ReconciledEnergyInfluence\<same as above>Double
Specific Energy CorrectionSpecific EnergySF_SpecificEnergyMeterTemplateSF_EnergyMeterTemplateReconciledSpecificEnergyCorrection\<same as above>Double
Energy CorrectionEnergy\<same as above>ReconciledEnergyCorrection\<same as above>Double
Test 1\<dimensionless>\<same as above>ReconciledEnergy Test1\<same as above>Double
Test 2\<dimensionless>\<same as above>ReconciledEnergy Test2\<same as above>Double
Initial Energy ImbalanceEnergySF_NodeTemplateSF_ProcessTemplateSF_ManifoldTemplateReconciledEnergyImbalance\<same as above>Double
Energy VarianceEnergy\<same as above>ReconciledEnergyVariance\<same as above>Double
Test 3\<dimensionless>\<same as above>ReconciledEnergyTest3\<same as above>Double
Test 4\<dimensionless>\<same as above>ReconciledEnergyTest4\<same as above>Double

Energy Balance Analysis – Heat Exchanger Attributes

Analysis Configuration – Required Heat Exchanger Attributes (Tube Side)

Configuration ParameterAttribute UnitTemplate Name(s)Default Attribute NameCategoryParameter Value Type
Initial ImbalanceEnergySF_HeatExchangerTemplateReconciledMassTubeImbalanceSF_AnalysisOutputDouble
VarianceEnergy\<same as above>ReconciledMassTubeVariance\<same as above>Double
Test 3\<dimensionless>\<same as above>ReconciledMassTubeTest3\<same as above>Double
Test 4\<dimensionless>\<same as above>ReconciledMassTubeTest4\<same as above>Double
Reconciled Residual\<dimensionless>\<same as above>ReconciledTubeResidual\<same as above>Double

Analysis Configuration – Required Heat Exchanger Attributes (Shell Side)

Configuration ParameterAttribute UnitTemplate Name(s)Default Attribute NameCategoryParameter Value Type
Initial ImbalanceEnergySF_HeatExchangerTemplateReconciledMassShellImbalanceSF_AnalysisOutputDouble
VarianceEnergy\<same as above>ReconciledMassShellVariance\<same as above>Double
Test 3\<dimensionless>\<same as above>ReconciledMassShellTest3\<same as above>Double
Test 4\<dimensionless>\<same as above>ReconciledMassShellTest4\<same as above>Double
Reconciled Residual\<dimensionless>\<same as above>ReconciledShellResidual\<same as above>Double